<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>    */<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    package org.uimafit.factory;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import java.io.File;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.net.MalformedURLException;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.net.URL;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.analysis_engine.AnalysisEngineDescription;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.resource.ConfigurableDataResourceSpecifier;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.resource.CustomResourceSpecifier;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.resource.DataResource;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.resource.ExternalResourceDependency;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.resource.ExternalResourceDescription;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.resource.FileResourceSpecifier;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.uima.resource.Parameter;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.uima.resource.Resource;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.uima.resource.ResourceManager;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.uima.resource.ResourceSpecifier;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.uima.resource.SharedResourceObject;<a name="line.37"></a>
<FONT color="green">038</FONT>    import org.apache.uima.resource.impl.ConfigurableDataResourceSpecifier_impl;<a name="line.38"></a>
<FONT color="green">039</FONT>    import org.apache.uima.resource.impl.CustomResourceSpecifier_impl;<a name="line.39"></a>
<FONT color="green">040</FONT>    import org.apache.uima.resource.impl.ExternalResourceDependency_impl;<a name="line.40"></a>
<FONT color="green">041</FONT>    import org.apache.uima.resource.impl.ExternalResourceDescription_impl;<a name="line.41"></a>
<FONT color="green">042</FONT>    import org.apache.uima.resource.impl.FileResourceSpecifier_impl;<a name="line.42"></a>
<FONT color="green">043</FONT>    import org.apache.uima.resource.impl.Parameter_impl;<a name="line.43"></a>
<FONT color="green">044</FONT>    import org.apache.uima.resource.metadata.ExternalResourceBinding;<a name="line.44"></a>
<FONT color="green">045</FONT>    import org.apache.uima.resource.metadata.ResourceManagerConfiguration;<a name="line.45"></a>
<FONT color="green">046</FONT>    import org.apache.uima.resource.metadata.impl.ExternalResourceBinding_impl;<a name="line.46"></a>
<FONT color="green">047</FONT>    import org.apache.uima.resource.metadata.impl.ResourceManagerConfiguration_impl;<a name="line.47"></a>
<FONT color="green">048</FONT>    import org.apache.uima.resource.metadata.impl.ResourceMetaData_impl;<a name="line.48"></a>
<FONT color="green">049</FONT>    import org.apache.uima.util.InvalidXMLException;<a name="line.49"></a>
<FONT color="green">050</FONT>    import org.uimafit.factory.ConfigurationParameterFactory.ConfigurationData;<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>    /**<a name="line.52"></a>
<FONT color="green">053</FONT>     * Helper methods for external resources.<a name="line.53"></a>
<FONT color="green">054</FONT>     *<a name="line.54"></a>
<FONT color="green">055</FONT>     * @author Richard Eckart de Castilho<a name="line.55"></a>
<FONT color="green">056</FONT>     */<a name="line.56"></a>
<FONT color="green">057</FONT>    public final class ExternalResourceFactory<a name="line.57"></a>
<FONT color="green">058</FONT>    {<a name="line.58"></a>
<FONT color="green">059</FONT>            private ExternalResourceFactory()<a name="line.59"></a>
<FONT color="green">060</FONT>            {<a name="line.60"></a>
<FONT color="green">061</FONT>                    // This class is not meant to be instantiated<a name="line.61"></a>
<FONT color="green">062</FONT>            }<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>            /**<a name="line.64"></a>
<FONT color="green">065</FONT>             * Create an external resource description for a custom resource.<a name="line.65"></a>
<FONT color="green">066</FONT>             *<a name="line.66"></a>
<FONT color="green">067</FONT>             * @param aName the name of the resource (the key).<a name="line.67"></a>
<FONT color="green">068</FONT>             * @param aInterface the interface the resource should implement.<a name="line.68"></a>
<FONT color="green">069</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.69"></a>
<FONT color="green">070</FONT>             * @return the description.<a name="line.70"></a>
<FONT color="green">071</FONT>             * @see CustomResourceSpecifier<a name="line.71"></a>
<FONT color="green">072</FONT>             */<a name="line.72"></a>
<FONT color="green">073</FONT>            public static ExternalResourceDescription createExternalResourceDescription(<a name="line.73"></a>
<FONT color="green">074</FONT>                            final String aName, Class&lt;? extends Resource&gt; aInterface,<a name="line.74"></a>
<FONT color="green">075</FONT>                            String... aParams)<a name="line.75"></a>
<FONT color="green">076</FONT>            {<a name="line.76"></a>
<FONT color="green">077</FONT>                    if (aParams.length % 2 != 0) {<a name="line.77"></a>
<FONT color="green">078</FONT>                            throw new IllegalArgumentException("Parameter arguments have to " +<a name="line.78"></a>
<FONT color="green">079</FONT>                                            "come in key/value pairs, but found odd number of " +<a name="line.79"></a>
<FONT color="green">080</FONT>                                            "arguments ["+ aParams.length + "]");<a name="line.80"></a>
<FONT color="green">081</FONT>                    }<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>                    int numberOfParameters = aParams.length / 2;<a name="line.83"></a>
<FONT color="green">084</FONT>                    Parameter[] params = new Parameter[numberOfParameters];<a name="line.84"></a>
<FONT color="green">085</FONT>                    for (int i = 0; i &lt; numberOfParameters; i++) {<a name="line.85"></a>
<FONT color="green">086</FONT>                            params[i] = new Parameter_impl();<a name="line.86"></a>
<FONT color="green">087</FONT>                            params[i].setName(aParams[i * 2]);<a name="line.87"></a>
<FONT color="green">088</FONT>                            params[i].setValue(aParams[i * 2 + 1]);<a name="line.88"></a>
<FONT color="green">089</FONT>                    }<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>                    CustomResourceSpecifier spec = new CustomResourceSpecifier_impl();<a name="line.91"></a>
<FONT color="green">092</FONT>                    spec.setResourceClassName(aInterface.getName());<a name="line.92"></a>
<FONT color="green">093</FONT>                    spec.setParameters(params);<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>                    ExternalResourceDescription extRes = new ExternalResourceDescription_impl();<a name="line.95"></a>
<FONT color="green">096</FONT>                    extRes.setName(aName);<a name="line.96"></a>
<FONT color="green">097</FONT>                    extRes.setResourceSpecifier(spec);<a name="line.97"></a>
<FONT color="green">098</FONT>                    return extRes;<a name="line.98"></a>
<FONT color="green">099</FONT>            }<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>            /**<a name="line.101"></a>
<FONT color="green">102</FONT>             * Create an external resource description for a {@link SharedResourceObject}.<a name="line.102"></a>
<FONT color="green">103</FONT>             *<a name="line.103"></a>
<FONT color="green">104</FONT>             * @param aName the name of the resource (the key).<a name="line.104"></a>
<FONT color="green">105</FONT>             * @param aInterface the interface the resource should implement.<a name="line.105"></a>
<FONT color="green">106</FONT>             * @param aUrl the URL from which the resource is initialized.<a name="line.106"></a>
<FONT color="green">107</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.107"></a>
<FONT color="green">108</FONT>             * @return the description.<a name="line.108"></a>
<FONT color="green">109</FONT>             * @see ConfigurableDataResourceSpecifier<a name="line.109"></a>
<FONT color="green">110</FONT>             * @see SharedResourceObject<a name="line.110"></a>
<FONT color="green">111</FONT>             */<a name="line.111"></a>
<FONT color="green">112</FONT>            public static ExternalResourceDescription createExternalResourceDescription(<a name="line.112"></a>
<FONT color="green">113</FONT>                            final String aName,<a name="line.113"></a>
<FONT color="green">114</FONT>                            Class&lt;? extends SharedResourceObject&gt; aInterface, String aUrl,<a name="line.114"></a>
<FONT color="green">115</FONT>                            Object... aParams)<a name="line.115"></a>
<FONT color="green">116</FONT>            {<a name="line.116"></a>
<FONT color="green">117</FONT>                    ConfigurationData cfg = ConfigurationParameterFactory.createConfigurationData(aParams);<a name="line.117"></a>
<FONT color="green">118</FONT>                    ResourceMetaData_impl meta = new ResourceMetaData_impl();<a name="line.118"></a>
<FONT color="green">119</FONT>                    ResourceCreationSpecifierFactory.setConfigurationParameters(meta,<a name="line.119"></a>
<FONT color="green">120</FONT>                                    cfg.configurationParameters, cfg.configurationValues);<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>                    ConfigurableDataResourceSpecifier_impl spec = new ConfigurableDataResourceSpecifier_impl();<a name="line.122"></a>
<FONT color="green">123</FONT>                    spec.setUrl(aUrl);<a name="line.123"></a>
<FONT color="green">124</FONT>                    spec.setMetaData(meta);<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>                    ExternalResourceDescription extRes = new ExternalResourceDescription_impl();<a name="line.126"></a>
<FONT color="green">127</FONT>                    extRes.setName(aName);<a name="line.127"></a>
<FONT color="green">128</FONT>                    extRes.setResourceSpecifier(spec);<a name="line.128"></a>
<FONT color="green">129</FONT>                    extRes.setImplementationName(aInterface.getName());<a name="line.129"></a>
<FONT color="green">130</FONT>                    return extRes;<a name="line.130"></a>
<FONT color="green">131</FONT>            }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>            /**<a name="line.133"></a>
<FONT color="green">134</FONT>             * Create an external resource description for a file addressable via an<a name="line.134"></a>
<FONT color="green">135</FONT>             * URL.<a name="line.135"></a>
<FONT color="green">136</FONT>             *<a name="line.136"></a>
<FONT color="green">137</FONT>             * @param aName the name of the resource (the key).<a name="line.137"></a>
<FONT color="green">138</FONT>             * @param aUrl a URL.<a name="line.138"></a>
<FONT color="green">139</FONT>             * @return the description.<a name="line.139"></a>
<FONT color="green">140</FONT>             * @see FileResourceSpecifier<a name="line.140"></a>
<FONT color="green">141</FONT>             */<a name="line.141"></a>
<FONT color="green">142</FONT>            public static ExternalResourceDescription createExternalResourceDescription(<a name="line.142"></a>
<FONT color="green">143</FONT>                            final String aName, String aUrl)<a name="line.143"></a>
<FONT color="green">144</FONT>            {<a name="line.144"></a>
<FONT color="green">145</FONT>                    ExternalResourceDescription extRes = new ExternalResourceDescription_impl();<a name="line.145"></a>
<FONT color="green">146</FONT>                    extRes.setName(aName);<a name="line.146"></a>
<FONT color="green">147</FONT>                    FileResourceSpecifier frs = new FileResourceSpecifier_impl();<a name="line.147"></a>
<FONT color="green">148</FONT>                    frs.setFileUrl(aUrl);<a name="line.148"></a>
<FONT color="green">149</FONT>                    extRes.setResourceSpecifier(frs);<a name="line.149"></a>
<FONT color="green">150</FONT>                    return extRes;<a name="line.150"></a>
<FONT color="green">151</FONT>            }<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>            /**<a name="line.153"></a>
<FONT color="green">154</FONT>             * Create an external resource binding.<a name="line.154"></a>
<FONT color="green">155</FONT>             *<a name="line.155"></a>
<FONT color="green">156</FONT>             * @param aKey the key to bind to.<a name="line.156"></a>
<FONT color="green">157</FONT>             * @param aResource the resource to bind.<a name="line.157"></a>
<FONT color="green">158</FONT>             * @return the description.<a name="line.158"></a>
<FONT color="green">159</FONT>             */<a name="line.159"></a>
<FONT color="green">160</FONT>            public static ExternalResourceBinding createExternalResourceBinding(<a name="line.160"></a>
<FONT color="green">161</FONT>                            final String aKey, final ExternalResourceDescription aResource)<a name="line.161"></a>
<FONT color="green">162</FONT>            {<a name="line.162"></a>
<FONT color="green">163</FONT>                    ExternalResourceBinding extResBind = new ExternalResourceBinding_impl();<a name="line.163"></a>
<FONT color="green">164</FONT>                    extResBind.setResourceName(aResource.getName());<a name="line.164"></a>
<FONT color="green">165</FONT>                    extResBind.setKey(aKey);<a name="line.165"></a>
<FONT color="green">166</FONT>                    return extResBind;<a name="line.166"></a>
<FONT color="green">167</FONT>            }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>            /**<a name="line.169"></a>
<FONT color="green">170</FONT>             * Creates an ExternalResourceDependency for a given key and interface <a name="line.170"></a>
<FONT color="green">171</FONT>             * @param aKey<a name="line.171"></a>
<FONT color="green">172</FONT>             * @param aInterface<a name="line.172"></a>
<FONT color="green">173</FONT>             * @param aOptional determines whether the dependency is optional<a name="line.173"></a>
<FONT color="green">174</FONT>             * @return<a name="line.174"></a>
<FONT color="green">175</FONT>             */<a name="line.175"></a>
<FONT color="green">176</FONT>            public static ExternalResourceDependency createExternalResourceDependency(<a name="line.176"></a>
<FONT color="green">177</FONT>                            final String aKey, final Class&lt;? extends Resource&gt; aInterface,<a name="line.177"></a>
<FONT color="green">178</FONT>                            final boolean aOptional)<a name="line.178"></a>
<FONT color="green">179</FONT>            {<a name="line.179"></a>
<FONT color="green">180</FONT>                    ExternalResourceDependency dep = new ExternalResourceDependency_impl();<a name="line.180"></a>
<FONT color="green">181</FONT>                    dep.setInterfaceName(aInterface.getName());<a name="line.181"></a>
<FONT color="green">182</FONT>                    dep.setKey(aKey);<a name="line.182"></a>
<FONT color="green">183</FONT>                    dep.setOptional(aOptional);<a name="line.183"></a>
<FONT color="green">184</FONT>                    return dep;<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>    <a name="line.186"></a>
<FONT color="green">187</FONT>            /**<a name="line.187"></a>
<FONT color="green">188</FONT>             * Scan the given resource specifier for external resource dependencies and whenever a<a name="line.188"></a>
<FONT color="green">189</FONT>             * dependency is encounter that has the specified key, the resource will be bound.<a name="line.189"></a>
<FONT color="green">190</FONT>             * &lt;p&gt;<a name="line.190"></a>
<FONT color="green">191</FONT>             * &lt;b&gt;Caveat&lt;/b&gt;: If you use this method, you may expect that {@link DataResource#getUrl()} or<a name="line.191"></a>
<FONT color="green">192</FONT>             * {@link DataResource#getUri()} will return the same URL that you have specified here. This<a name="line.192"></a>
<FONT color="green">193</FONT>             * may &lt;b&gt;NOT&lt;/b&gt; be the case. UIMA will internally try to resolve the URL via a<a name="line.193"></a>
<FONT color="green">194</FONT>         * {@link ResourceManager}. If it cannot resolve a remove URL, this mechanism will think it<a name="line.194"></a>
<FONT color="green">195</FONT>         * may be a local file and will return some local path - or it may redirect it to some location<a name="line.195"></a>
<FONT color="green">196</FONT>         * as though fit by the {@link ResourceManager}.<a name="line.196"></a>
<FONT color="green">197</FONT>             *<a name="line.197"></a>
<FONT color="green">198</FONT>             * @param aDesc a description.<a name="line.198"></a>
<FONT color="green">199</FONT>             * @param aKey the key to bind to.<a name="line.199"></a>
<FONT color="green">200</FONT>             * @param aUrl a URL.<a name="line.200"></a>
<FONT color="green">201</FONT>             * @throws InvalidXMLException<a name="line.201"></a>
<FONT color="green">202</FONT>             * @see FileResourceSpecifier<a name="line.202"></a>
<FONT color="green">203</FONT>             */<a name="line.203"></a>
<FONT color="green">204</FONT>            public static void bindResource(ResourceSpecifier aDesc, String aKey,<a name="line.204"></a>
<FONT color="green">205</FONT>                            URL aUrl)<a name="line.205"></a>
<FONT color="green">206</FONT>                    throws InvalidXMLException<a name="line.206"></a>
<FONT color="green">207</FONT>            {<a name="line.207"></a>
<FONT color="green">208</FONT>                    bindResource(aDesc, aKey, aUrl.toString());<a name="line.208"></a>
<FONT color="green">209</FONT>            }<a name="line.209"></a>
<FONT color="green">210</FONT>    <a name="line.210"></a>
<FONT color="green">211</FONT>            /**<a name="line.211"></a>
<FONT color="green">212</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.212"></a>
<FONT color="green">213</FONT>             * and whenever a dependency is encounter that has the specified key,<a name="line.213"></a>
<FONT color="green">214</FONT>             * the resource will be bound.<a name="line.214"></a>
<FONT color="green">215</FONT>             * &lt;p&gt;<a name="line.215"></a>
<FONT color="green">216</FONT>             * &lt;b&gt;Caveat&lt;/b&gt;: If you use this method, you may expect that {@link DataResource#getUrl()} or<a name="line.216"></a>
<FONT color="green">217</FONT>             * {@link DataResource#getUri()} will return the URL of the file that you have specified here.<a name="line.217"></a>
<FONT color="green">218</FONT>         * This may &lt;b&gt;NOT&lt;/b&gt; be the case. UIMA will internally try to resolve the URL via a<a name="line.218"></a>
<FONT color="green">219</FONT>         * {@link ResourceManager}. If it cannot resolve a remove URL, this mechanism will think it<a name="line.219"></a>
<FONT color="green">220</FONT>         * may be a local file and will return some local path - or it may redirect it to some location<a name="line.220"></a>
<FONT color="green">221</FONT>         * as though fit by the {@link ResourceManager}.<a name="line.221"></a>
<FONT color="green">222</FONT>             *<a name="line.222"></a>
<FONT color="green">223</FONT>             * @param aDesc a description.<a name="line.223"></a>
<FONT color="green">224</FONT>             * @param aKey the key to bind to.<a name="line.224"></a>
<FONT color="green">225</FONT>             * @param aFile a file.<a name="line.225"></a>
<FONT color="green">226</FONT>             * @throws InvalidXMLException<a name="line.226"></a>
<FONT color="green">227</FONT>             * @see FileResourceSpecifier<a name="line.227"></a>
<FONT color="green">228</FONT>             */<a name="line.228"></a>
<FONT color="green">229</FONT>            public static void bindResource(ResourceSpecifier aDesc, String aKey,<a name="line.229"></a>
<FONT color="green">230</FONT>                            File aFile)<a name="line.230"></a>
<FONT color="green">231</FONT>                    throws InvalidXMLException<a name="line.231"></a>
<FONT color="green">232</FONT>            {<a name="line.232"></a>
<FONT color="green">233</FONT>                    try {<a name="line.233"></a>
<FONT color="green">234</FONT>                            bindResource(aDesc, aKey, aFile.toURI().toURL());<a name="line.234"></a>
<FONT color="green">235</FONT>                    }<a name="line.235"></a>
<FONT color="green">236</FONT>                    catch (MalformedURLException e) {<a name="line.236"></a>
<FONT color="green">237</FONT>                            // This is something that usually cannot happen, so we degrade this<a name="line.237"></a>
<FONT color="green">238</FONT>                            // to an IllegalArgumentException which is a RuntimeException that<a name="line.238"></a>
<FONT color="green">239</FONT>                            // does not need to be catched.<a name="line.239"></a>
<FONT color="green">240</FONT>                            throw new IllegalArgumentException("File converts to illegal URL ["<a name="line.240"></a>
<FONT color="green">241</FONT>                                            + aFile + "]");<a name="line.241"></a>
<FONT color="green">242</FONT>                    }<a name="line.242"></a>
<FONT color="green">243</FONT>            }<a name="line.243"></a>
<FONT color="green">244</FONT>    <a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>            /**<a name="line.246"></a>
<FONT color="green">247</FONT>             * Scan the given resource specifier for external resource dependencies and whenever a<a name="line.247"></a>
<FONT color="green">248</FONT>             * dependency is encounter that has the specified key, the resource will be bound.<a name="line.248"></a>
<FONT color="green">249</FONT>             * &lt;p&gt;<a name="line.249"></a>
<FONT color="green">250</FONT>             * &lt;b&gt;Caveat&lt;/b&gt;: If you use this method, you may expect that {@link DataResource#getUrl()} or<a name="line.250"></a>
<FONT color="green">251</FONT>             * {@link DataResource#getUri()} will return the same URL that you have specified here. This<a name="line.251"></a>
<FONT color="green">252</FONT>             * is may &lt;b&gt;NOT&lt;/b&gt; be the case. UIMA will internally try to resolve the URL via a<a name="line.252"></a>
<FONT color="green">253</FONT>         * {@link ResourceManager}. If it cannot resolve a remove URL, this mechanism will think it<a name="line.253"></a>
<FONT color="green">254</FONT>         * may be a local file and will return some local path - or it may redirect it to some location<a name="line.254"></a>
<FONT color="green">255</FONT>         * as though fit by the {@link ResourceManager}.<a name="line.255"></a>
<FONT color="green">256</FONT>             *<a name="line.256"></a>
<FONT color="green">257</FONT>             * @param aDesc a description.<a name="line.257"></a>
<FONT color="green">258</FONT>             * @param aKey the key to bind to.<a name="line.258"></a>
<FONT color="green">259</FONT>             * @param aUrl a URL.<a name="line.259"></a>
<FONT color="green">260</FONT>             * @throws InvalidXMLException<a name="line.260"></a>
<FONT color="green">261</FONT>             * @see FileResourceSpecifier<a name="line.261"></a>
<FONT color="green">262</FONT>             */<a name="line.262"></a>
<FONT color="green">263</FONT>            public static void bindResource(ResourceSpecifier aDesc, String aKey,<a name="line.263"></a>
<FONT color="green">264</FONT>                            String aUrl)<a name="line.264"></a>
<FONT color="green">265</FONT>                    throws InvalidXMLException<a name="line.265"></a>
<FONT color="green">266</FONT>            {<a name="line.266"></a>
<FONT color="green">267</FONT>                    ExternalResourceDescription extRes = createExternalResourceDescription(<a name="line.267"></a>
<FONT color="green">268</FONT>                                    aKey, aUrl);<a name="line.268"></a>
<FONT color="green">269</FONT>                    bindResource(aDesc, aKey, extRes);<a name="line.269"></a>
<FONT color="green">270</FONT>            }<a name="line.270"></a>
<FONT color="green">271</FONT>    <a name="line.271"></a>
<FONT color="green">272</FONT>            /**<a name="line.272"></a>
<FONT color="green">273</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.273"></a>
<FONT color="green">274</FONT>             * and whenever a dependency is encounter that has a key equal to the<a name="line.274"></a>
<FONT color="green">275</FONT>             * resource class name, the resource will be bound.<a name="line.275"></a>
<FONT color="green">276</FONT>             *<a name="line.276"></a>
<FONT color="green">277</FONT>             * @param aDesc a description.<a name="line.277"></a>
<FONT color="green">278</FONT>             * @param aRes the resource to bind.<a name="line.278"></a>
<FONT color="green">279</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.279"></a>
<FONT color="green">280</FONT>             * @throws InvalidXMLException<a name="line.280"></a>
<FONT color="green">281</FONT>             * @see CustomResourceSpecifier<a name="line.281"></a>
<FONT color="green">282</FONT>             */<a name="line.282"></a>
<FONT color="green">283</FONT>            public static void bindResource(ResourceSpecifier aDesc,<a name="line.283"></a>
<FONT color="green">284</FONT>                            Class&lt;? extends Resource&gt; aRes, String... aParams)<a name="line.284"></a>
<FONT color="green">285</FONT>                    throws InvalidXMLException<a name="line.285"></a>
<FONT color="green">286</FONT>            {<a name="line.286"></a>
<FONT color="green">287</FONT>                    bindResource(aDesc, aRes, aRes, aParams);<a name="line.287"></a>
<FONT color="green">288</FONT>            }<a name="line.288"></a>
<FONT color="green">289</FONT>    <a name="line.289"></a>
<FONT color="green">290</FONT>            /**<a name="line.290"></a>
<FONT color="green">291</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.291"></a>
<FONT color="green">292</FONT>             * and whenever a dependency is encounter that has a key equal to the<a name="line.292"></a>
<FONT color="green">293</FONT>             * API class name, the resource will be bound.<a name="line.293"></a>
<FONT color="green">294</FONT>             *<a name="line.294"></a>
<FONT color="green">295</FONT>             * @param aDesc a description.<a name="line.295"></a>
<FONT color="green">296</FONT>             * @param aApi the resource interface.<a name="line.296"></a>
<FONT color="green">297</FONT>             * @param aRes the resource to bind.<a name="line.297"></a>
<FONT color="green">298</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.298"></a>
<FONT color="green">299</FONT>             * @throws InvalidXMLException<a name="line.299"></a>
<FONT color="green">300</FONT>             * @see CustomResourceSpecifier<a name="line.300"></a>
<FONT color="green">301</FONT>             */<a name="line.301"></a>
<FONT color="green">302</FONT>            public static void bindResource(ResourceSpecifier aDesc,<a name="line.302"></a>
<FONT color="green">303</FONT>                            Class&lt;?&gt; aApi, Class&lt;? extends Resource&gt; aRes,<a name="line.303"></a>
<FONT color="green">304</FONT>                            String... aParams)<a name="line.304"></a>
<FONT color="green">305</FONT>                    throws InvalidXMLException<a name="line.305"></a>
<FONT color="green">306</FONT>            {<a name="line.306"></a>
<FONT color="green">307</FONT>                    ExternalResourceDescription extRes = createExternalResourceDescription(<a name="line.307"></a>
<FONT color="green">308</FONT>                                    aApi.getName(), aRes, aParams);<a name="line.308"></a>
<FONT color="green">309</FONT>                    bindResource(aDesc, aApi.getName(), extRes);<a name="line.309"></a>
<FONT color="green">310</FONT>            }<a name="line.310"></a>
<FONT color="green">311</FONT>    <a name="line.311"></a>
<FONT color="green">312</FONT>            /**<a name="line.312"></a>
<FONT color="green">313</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.313"></a>
<FONT color="green">314</FONT>             * and whenever a dependency is encountered that has a key equal to the<a name="line.314"></a>
<FONT color="green">315</FONT>             * resource class name, the resource will be bound.<a name="line.315"></a>
<FONT color="green">316</FONT>             *<a name="line.316"></a>
<FONT color="green">317</FONT>             * @param aDesc a description.<a name="line.317"></a>
<FONT color="green">318</FONT>             * @param aRes the resource to bind.<a name="line.318"></a>
<FONT color="green">319</FONT>             * @param aUrl the URL from which the resource is initialized.<a name="line.319"></a>
<FONT color="green">320</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.320"></a>
<FONT color="green">321</FONT>             * @throws InvalidXMLException<a name="line.321"></a>
<FONT color="green">322</FONT>             * @see SharedResourceObject<a name="line.322"></a>
<FONT color="green">323</FONT>             */<a name="line.323"></a>
<FONT color="green">324</FONT>            public static void bindResource(ResourceSpecifier aDesc,<a name="line.324"></a>
<FONT color="green">325</FONT>                            Class&lt;? extends SharedResourceObject&gt; aRes,<a name="line.325"></a>
<FONT color="green">326</FONT>                            String aUrl, Object... aParams)<a name="line.326"></a>
<FONT color="green">327</FONT>                    throws InvalidXMLException<a name="line.327"></a>
<FONT color="green">328</FONT>            {<a name="line.328"></a>
<FONT color="green">329</FONT>                    bindResource(aDesc, aRes, aRes, aUrl, aParams);<a name="line.329"></a>
<FONT color="green">330</FONT>            }<a name="line.330"></a>
<FONT color="green">331</FONT>    <a name="line.331"></a>
<FONT color="green">332</FONT>            /**<a name="line.332"></a>
<FONT color="green">333</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.333"></a>
<FONT color="green">334</FONT>             * and whenever a dependency is encountered that has a key equal to the<a name="line.334"></a>
<FONT color="green">335</FONT>             * API class name, the resource will be bound.<a name="line.335"></a>
<FONT color="green">336</FONT>             *<a name="line.336"></a>
<FONT color="green">337</FONT>             * @param aDesc a description.<a name="line.337"></a>
<FONT color="green">338</FONT>             * @param aApi the resource interface.<a name="line.338"></a>
<FONT color="green">339</FONT>             * @param aRes the resource to bind.<a name="line.339"></a>
<FONT color="green">340</FONT>             * @param aUrl the URL from which the resource is initialized.<a name="line.340"></a>
<FONT color="green">341</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.341"></a>
<FONT color="green">342</FONT>             * @throws InvalidXMLException<a name="line.342"></a>
<FONT color="green">343</FONT>             * @see SharedResourceObject<a name="line.343"></a>
<FONT color="green">344</FONT>             */<a name="line.344"></a>
<FONT color="green">345</FONT>            public static void bindResource(ResourceSpecifier aDesc,<a name="line.345"></a>
<FONT color="green">346</FONT>                            Class&lt;?&gt; aApi, Class&lt;? extends SharedResourceObject&gt; aRes,<a name="line.346"></a>
<FONT color="green">347</FONT>                            String aUrl, Object... aParams)<a name="line.347"></a>
<FONT color="green">348</FONT>                    throws InvalidXMLException<a name="line.348"></a>
<FONT color="green">349</FONT>            {<a name="line.349"></a>
<FONT color="green">350</FONT>                    bindResource(aDesc, aApi.getName(), aRes, aUrl, aParams);<a name="line.350"></a>
<FONT color="green">351</FONT>            }<a name="line.351"></a>
<FONT color="green">352</FONT>    <a name="line.352"></a>
<FONT color="green">353</FONT>            /**<a name="line.353"></a>
<FONT color="green">354</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.354"></a>
<FONT color="green">355</FONT>             * and whenever a dependency with the given key is encountered the<a name="line.355"></a>
<FONT color="green">356</FONT>             * resource will be bound.<a name="line.356"></a>
<FONT color="green">357</FONT>             *<a name="line.357"></a>
<FONT color="green">358</FONT>             * @param aDesc a description.<a name="line.358"></a>
<FONT color="green">359</FONT>             * @param aKey the key to bind to.<a name="line.359"></a>
<FONT color="green">360</FONT>             * @param aRes the resource to bind.<a name="line.360"></a>
<FONT color="green">361</FONT>             * @param aUrl the URL from which the resource is initialized.<a name="line.361"></a>
<FONT color="green">362</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.362"></a>
<FONT color="green">363</FONT>             * @throws InvalidXMLException<a name="line.363"></a>
<FONT color="green">364</FONT>             * @see SharedResourceObject<a name="line.364"></a>
<FONT color="green">365</FONT>             */<a name="line.365"></a>
<FONT color="green">366</FONT>            public static void bindResource(ResourceSpecifier aDesc,<a name="line.366"></a>
<FONT color="green">367</FONT>                            String aKey, Class&lt;? extends SharedResourceObject&gt; aRes,<a name="line.367"></a>
<FONT color="green">368</FONT>                            String aUrl, Object... aParams)<a name="line.368"></a>
<FONT color="green">369</FONT>                    throws InvalidXMLException<a name="line.369"></a>
<FONT color="green">370</FONT>            {<a name="line.370"></a>
<FONT color="green">371</FONT>                            ExternalResourceDescription extRes = createExternalResourceDescription(<a name="line.371"></a>
<FONT color="green">372</FONT>                                            aKey, aRes, aUrl, aParams);<a name="line.372"></a>
<FONT color="green">373</FONT>                            bind((AnalysisEngineDescription) aDesc, aKey, extRes);<a name="line.373"></a>
<FONT color="green">374</FONT>            }<a name="line.374"></a>
<FONT color="green">375</FONT>    <a name="line.375"></a>
<FONT color="green">376</FONT>            /**<a name="line.376"></a>
<FONT color="green">377</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.377"></a>
<FONT color="green">378</FONT>             * and whenever a dependency with the given key is encountered, the given<a name="line.378"></a>
<FONT color="green">379</FONT>             * resource is bound to it.<a name="line.379"></a>
<FONT color="green">380</FONT>             *<a name="line.380"></a>
<FONT color="green">381</FONT>             * @param aDesc a description.<a name="line.381"></a>
<FONT color="green">382</FONT>             * @param aKey the key to bind to.<a name="line.382"></a>
<FONT color="green">383</FONT>             * @param aRes the resource to bind.<a name="line.383"></a>
<FONT color="green">384</FONT>             * @param aParams parameters passed to the resource when it is created.<a name="line.384"></a>
<FONT color="green">385</FONT>             * @throws InvalidXMLException<a name="line.385"></a>
<FONT color="green">386</FONT>             * @see CustomResourceSpecifier<a name="line.386"></a>
<FONT color="green">387</FONT>             */<a name="line.387"></a>
<FONT color="green">388</FONT>            public static void bindResource(ResourceSpecifier aDesc, String aKey,<a name="line.388"></a>
<FONT color="green">389</FONT>                            Class&lt;? extends Resource&gt; aRes, String... aParams)<a name="line.389"></a>
<FONT color="green">390</FONT>                    throws InvalidXMLException<a name="line.390"></a>
<FONT color="green">391</FONT>            {<a name="line.391"></a>
<FONT color="green">392</FONT>                    ExternalResourceDescription extRes = createExternalResourceDescription(<a name="line.392"></a>
<FONT color="green">393</FONT>                                    aRes.getName(), aRes, aParams);<a name="line.393"></a>
<FONT color="green">394</FONT>                    bindResource(aDesc, aKey, extRes);<a name="line.394"></a>
<FONT color="green">395</FONT>            }<a name="line.395"></a>
<FONT color="green">396</FONT>            /**<a name="line.396"></a>
<FONT color="green">397</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.397"></a>
<FONT color="green">398</FONT>             * and whenever a dependency with the given key is encountered, the given<a name="line.398"></a>
<FONT color="green">399</FONT>             * resource is bound to it.<a name="line.399"></a>
<FONT color="green">400</FONT>             *<a name="line.400"></a>
<FONT color="green">401</FONT>             * @param aDesc a description.<a name="line.401"></a>
<FONT color="green">402</FONT>             * @param aKey the key to bind to.<a name="line.402"></a>
<FONT color="green">403</FONT>             * @param aResDesc the resource description.<a name="line.403"></a>
<FONT color="green">404</FONT>             * @throws InvalidXMLException<a name="line.404"></a>
<FONT color="green">405</FONT>             */<a name="line.405"></a>
<FONT color="green">406</FONT>            public static void bindResource(ResourceSpecifier aDesc, String aKey,<a name="line.406"></a>
<FONT color="green">407</FONT>                            ExternalResourceDescription aResDesc)<a name="line.407"></a>
<FONT color="green">408</FONT>                    throws InvalidXMLException<a name="line.408"></a>
<FONT color="green">409</FONT>            {<a name="line.409"></a>
<FONT color="green">410</FONT>                    // Dispatch<a name="line.410"></a>
<FONT color="green">411</FONT>                    if (aDesc instanceof AnalysisEngineDescription) {<a name="line.411"></a>
<FONT color="green">412</FONT>                            bind((AnalysisEngineDescription) aDesc, aKey, aResDesc);<a name="line.412"></a>
<FONT color="green">413</FONT>                    }<a name="line.413"></a>
<FONT color="green">414</FONT>            }<a name="line.414"></a>
<FONT color="green">415</FONT>    <a name="line.415"></a>
<FONT color="green">416</FONT>            /**<a name="line.416"></a>
<FONT color="green">417</FONT>             * Scan the given resource specifier for external resource dependencies<a name="line.417"></a>
<FONT color="green">418</FONT>             * and whenever a dependency with the given key is encountered, the given<a name="line.418"></a>
<FONT color="green">419</FONT>             * resource is bound to it.<a name="line.419"></a>
<FONT color="green">420</FONT>             *<a name="line.420"></a>
<FONT color="green">421</FONT>             * @param aDesc a description.<a name="line.421"></a>
<FONT color="green">422</FONT>             * @param aKey the key to bind to.<a name="line.422"></a>
<FONT color="green">423</FONT>             * @param aResDesc the resource description.<a name="line.423"></a>
<FONT color="green">424</FONT>             * @throws InvalidXMLException<a name="line.424"></a>
<FONT color="green">425</FONT>             */<a name="line.425"></a>
<FONT color="green">426</FONT>            private static void bind(AnalysisEngineDescription aDesc, String aKey,<a name="line.426"></a>
<FONT color="green">427</FONT>                            ExternalResourceDescription aResDesc)<a name="line.427"></a>
<FONT color="green">428</FONT>                    throws InvalidXMLException<a name="line.428"></a>
<FONT color="green">429</FONT>            {<a name="line.429"></a>
<FONT color="green">430</FONT>                    // Recursively address delegates<a name="line.430"></a>
<FONT color="green">431</FONT>                    if (!aDesc.isPrimitive()) {<a name="line.431"></a>
<FONT color="green">432</FONT>                            for(Object delegate : aDesc.getDelegateAnalysisEngineSpecifiers().values()) {<a name="line.432"></a>
<FONT color="green">433</FONT>                                    bindResource((ResourceSpecifier) delegate, aKey, aResDesc);<a name="line.433"></a>
<FONT color="green">434</FONT>                            }<a name="line.434"></a>
<FONT color="green">435</FONT>                    }<a name="line.435"></a>
<FONT color="green">436</FONT>    <a name="line.436"></a>
<FONT color="green">437</FONT>                    // Bind if necessary<a name="line.437"></a>
<FONT color="green">438</FONT>                    for (ExternalResourceDependency dep : aDesc.getExternalResourceDependencies()) {<a name="line.438"></a>
<FONT color="green">439</FONT>                            if (aKey.equals(dep.getKey())) {<a name="line.439"></a>
<FONT color="green">440</FONT>    <a name="line.440"></a>
<FONT color="green">441</FONT>                                    ResourceManagerConfiguration resMgrCfg = aDesc.getResourceManagerConfiguration();<a name="line.441"></a>
<FONT color="green">442</FONT>                                    if (resMgrCfg == null) {<a name="line.442"></a>
<FONT color="green">443</FONT>                                            resMgrCfg = new ResourceManagerConfiguration_impl();<a name="line.443"></a>
<FONT color="green">444</FONT>                                            aDesc.setResourceManagerConfiguration(resMgrCfg);<a name="line.444"></a>
<FONT color="green">445</FONT>                                    }<a name="line.445"></a>
<FONT color="green">446</FONT>                                    bindExternalResource(resMgrCfg, aKey, aResDesc);<a name="line.446"></a>
<FONT color="green">447</FONT>                            }<a name="line.447"></a>
<FONT color="green">448</FONT>                    }<a name="line.448"></a>
<FONT color="green">449</FONT>            }<a name="line.449"></a>
<FONT color="green">450</FONT>    <a name="line.450"></a>
<FONT color="green">451</FONT>            /**<a name="line.451"></a>
<FONT color="green">452</FONT>             * Create a new external resource binding.<a name="line.452"></a>
<FONT color="green">453</FONT>             *<a name="line.453"></a>
<FONT color="green">454</FONT>             * @param aResMgrCfg the resource manager to create the binding in.<a name="line.454"></a>
<FONT color="green">455</FONT>             * @param aBindTo what key to bind to.<a name="line.455"></a>
<FONT color="green">456</FONT>             * @param aRes the resource that should be bound.<a name="line.456"></a>
<FONT color="green">457</FONT>             */<a name="line.457"></a>
<FONT color="green">458</FONT>            public static void bindExternalResource(<a name="line.458"></a>
<FONT color="green">459</FONT>                            ResourceManagerConfiguration aResMgrCfg, String aBindTo,<a name="line.459"></a>
<FONT color="green">460</FONT>                            ExternalResourceDescription aRes)<a name="line.460"></a>
<FONT color="green">461</FONT>            {<a name="line.461"></a>
<FONT color="green">462</FONT>                    ExternalResourceBinding extResBind = createExternalResourceBinding(<a name="line.462"></a>
<FONT color="green">463</FONT>                                    aBindTo, aRes);<a name="line.463"></a>
<FONT color="green">464</FONT>    <a name="line.464"></a>
<FONT color="green">465</FONT>                    aResMgrCfg.addExternalResource(aRes);<a name="line.465"></a>
<FONT color="green">466</FONT>                    aResMgrCfg.addExternalResourceBinding(extResBind);<a name="line.466"></a>
<FONT color="green">467</FONT>            }<a name="line.467"></a>
<FONT color="green">468</FONT>    }<a name="line.468"></a>




























































</PRE>
</BODY>
</HTML>
